Skip to content

docs: open source readiness - documentation and community files#4

Open
dviejokfs wants to merge 5 commits intomainfrom
docs/open-source-readiness
Open

docs: open source readiness - documentation and community files#4
dviejokfs wants to merge 5 commits intomainfrom
docs/open-source-readiness

Conversation

@dviejokfs
Copy link
Contributor

Summary

  • Add missing community files for open source readiness (CODE_OF_CONDUCT.md, CHANGELOG.md, GitHub issue/PR templates)
  • Add comprehensive user-facing documentation for previously undocumented features (CLI reference, REST API, tunnel security, transport protocols, project configuration, reverse tunnels)
  • Fix Cargo.toml repository URL to point to localup-dev/localup

New Files

Community / Open Source

  • CODE_OF_CONDUCT.md - Contributor Covenant v2.1 (was referenced in CONTRIBUTING.md but missing)
  • CHANGELOG.md - Full version history from v0.0.1-beta through v0.1.9
  • .github/ISSUE_TEMPLATE/bug_report.yml - Structured bug report form
  • .github/ISSUE_TEMPLATE/feature_request.yml - Feature request form
  • .github/PULL_REQUEST_TEMPLATE.md - PR template with CI checklist

User Documentation (docs/)

  • cli-reference.md - Complete reference for all commands, flags, and environment variables
  • api-reference.md - REST API endpoints with curl examples (tunnels, traffic inspection, domains, ACME, auth, device auth, API keys)
  • tunnel-security.md - JWT authentication, HTTP Basic/Bearer auth, IP allowlisting
  • transports.md - QUIC vs WebSocket vs H2 comparison and selection guide
  • configuration.md - .localup.yml format, localup init, up/down, daemon, system service
  • reverse-tunnels.md - Agent mode, connect command, agent-server, private service access patterns

Fix

  • Cargo.toml - Repository URL corrected from tunnel/geo-tunnel to localup-dev/localup

Test plan

  • All pre-commit hooks pass (yaml, whitespace, typos)
  • Review documentation accuracy against actual CLI --help output
  • Verify API endpoints match current implementation
  • Check all example commands are runnable

Add missing documentation for open source readiness:

- CODE_OF_CONDUCT.md (Contributor Covenant v2.1)
- CHANGELOG.md (full version history from v0.0.1-beta to v0.1.9)
- .github/ISSUE_TEMPLATE/bug_report.yml
- .github/ISSUE_TEMPLATE/feature_request.yml
- .github/PULL_REQUEST_TEMPLATE.md
- docs/cli-reference.md (complete CLI reference)
- docs/api-reference.md (REST API with curl examples)
- docs/tunnel-security.md (JWT, HTTP auth, IP allowlisting)
- docs/transports.md (QUIC vs WebSocket vs H2 guide)
- docs/configuration.md (.localup.yml format and usage)
- docs/reverse-tunnels.md (agent mode and private service access)

Fix Cargo.toml repository URL to point to correct GitHub repo.
Local release workflow for the Tauri desktop app with version
bumping, building, optional Apple notarization, Tauri auto-updater
support, and GitHub Release creation.
CLI reference:
- Remove --transport from Common Relay Options (only exists on relay http)
- Add TLS Relay Extras section (--http-redirect-addr, --https-redirect-port, --http-passthrough-addr)
- Add --oauth-client and --transport to HTTP Relay Extras
- Add OAUTH_CLIENTS env var to relay server section
- Document daemon add flags with correct default (https, not http)
- Add --custom-domain flag to daemon add

API reference:
- Add 11 missing endpoints: magic link send/verify, device info/deny,
  ACME challenge list/cancel/restart, GET auth-token by ID,
  ACME HTTP-01 challenge serving, teams list
CI pipeline fixes:
- Add GTK/glib/WebKit system dependencies for Tauri desktop build
- Add Bun to lint, test, build, and E2E jobs (needed by localup-client build script)

Node.js SDK lint fixes:
- Sort imports alphabetically (biome organizeImports)
- Use Number.parseInt instead of global parseInt
- Use string literals instead of unnecessary template literals
- Add trailing commas per biome formatter
- Break long lines per biome line width (100)
- Disable noExplicitAny for quic.ts (optional dynamic imports)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant